home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / alGetFD.z / alGetFD
Encoding:
Text File  |  1998-10-20  |  3.7 KB  |  67 lines

  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttFFFFDDDD((((3333ddddmmmm))))                                                      aaaallllGGGGeeeettttFFFFDDDD((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetFD - get the file descriptor for an audio port
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      iiiinnnntttt aaaallllGGGGeeeettttFFFFDDDD((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _p_o_r_t   expects the AAAALLLLppppoooorrrrtttt structure whose file descriptor you desire.
  18.             This structure is the returned value of an aaaallllOOOOppppeeeennnnPPPPoooorrrrtttt((((3333ddddmmmm)))) call.
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      aaaallllGGGGeeeettttFFFFDDDD(((()))) returns a file descriptor that you can use to construct the
  22.      arguments to a sssseeeelllleeeecccctttt((((2222))))  or ppppoooollllllll((((2222)))) call.
  23.  
  24.      These calls are used when you want to block a process until the device
  25.      fills or empties the audio port past a fillpoint (see the
  26.      aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((3333ddddmmmm)))) manual page). At that time, sssseeeelllleeeecccctttt((((2222)))) and ppppoooollllllll((((2222))))
  27.      return, and your code can continue processing the audio ports.  If the
  28.      device has already filled or emptied the audio port buffer past the
  29.      fillpoint when you make the call, control returns to your program
  30.      immediately.
  31.  
  32.      When using sssseeeelllleeeecccctttt((((2222)))), an input port's file descriptor is used in a read
  33.      fdset and an output port's file descriptor is used in a write fdset.
  34.  
  35.      When using ppppoooollllllll((((2222)))), an input port's file descriptor is used with the
  36.      POLLIN event flag and an output port's file descriptor is used with a
  37.      POLLOUT event flag.
  38.  
  39.      Several AL functions implicitly change the current fillpoint value.
  40.      Therefore, aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((3333ddddmmmm)))) must be called immediately before a
  41.      sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))) call which uses an audio file descriptor.
  42.  
  43. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  44.      Upon successful completion, aaaallllGGGGeeeettttFFFFDDDD returns a valid file descriptor.
  45.      Otherwise, aaaallllGGGGeeeettttFFFFDDDD returns -1 and sets an error number which can be
  46.      retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  47.  
  48.      aaaallllGGGGeeeettttFFFFDDDD can fail for the following reason:
  49.  
  50.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT   _p_o_r_t is either invalid or null.
  51.  
  52. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  53.      alSetFillPoint(3dm), alGetFillPoint(3dm), alOpenPort(3dm), select(2),
  54.      poll(2), oserror(3C)
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.